From 04fb95ce9f65f3464bcabe42d1c6092ac6719a7d Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Wed, 17 Feb 2021 14:22:54 +0000 Subject: [PATCH] docs: Split GdkDrag and GdkDrop sections This way we have a section for each class. --- gdk/gdkdrag.c | 47 ++++++++++++++++++----------------------------- gdk/gdkdrop.c | 22 ++++++++++++++++++++++ 2 files changed, 40 insertions(+), 29 deletions(-) diff --git a/gdk/gdkdrag.c b/gdk/gdkdrag.c index 2870d346d6..9b54924c56 100644 --- a/gdk/gdkdrag.c +++ b/gdk/gdkdrag.c @@ -22,6 +22,24 @@ * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ +/** + * SECTION:gdkdrag + * @Title: Drag And Drop + * @Short_description: Functions for controlling drag and drop handling + * + * These functions provide a low-level interface for drag and drop. + * + * The `GdkDrag` object represents the source side of an ongoing DND operation. + * It is created when a drag is started, and stays alive for duration of + * the DND operation. After a drag has been started with [method@Gdk.Drag.begin], + * the caller gets informed about the status of the ongoing drag operation + * with signals on the `GdkDrag` object. + * + * GTK provides a higher level abstraction based on top of these functions, + * and so they are not normally needed in GTK applications. See the + * "Drag and Drop" section of the GTK documentation for more information. + */ + #include "config.h" #include "gdkdragprivate.h" @@ -88,35 +106,6 @@ static GList *drags = NULL; G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GdkDrag, gdk_drag, G_TYPE_OBJECT) -/** - * SECTION:dnd - * @Title: Drag And Drop - * @Short_description: Functions for controlling drag and drop handling - * - * These functions provide a low-level interface for drag and drop. - * - * The GdkDrag object represents the source side of an ongoing DND operation. - * It is created when a drag is started, and stays alive for duration of - * the DND operation. After a drag has been started with gdk_drag_begin(), - * the caller gets informed about the status of the ongoing drag operation - * with signals on the #GdkDrag object. - * - * The GdkDrop object represents the target side of an ongoing DND operation. - * Possible drop sites get informed about the status of the ongoing drag operation - * with events of type %GDK_DRAG_ENTER, %GDK_DRAG_LEAVE, %GDK_DRAG_MOTION and - * %GDK_DROP_START. The #GdkDrop object can be obtained from these #GdkEvents - * using gdk_dnd_event_get_drop(). - * - * The actual data transfer is initiated from the target side via an async - * read, using one of the GdkDrop functions for this purpose: gdk_drop_read_async() - * or gdk_drop_read_value_async(). - * - * GTK provides a higher level abstraction based on top of these functions, - * and so they are not normally needed in GTK applications. See the - * [Drag and Drop][gtk4-Drag-and-Drop] section of the GTK documentation - * for more information. - */ - /** * GdkDrag: * diff --git a/gdk/gdkdrop.c b/gdk/gdkdrop.c index 487069d4f7..289c30ee5d 100644 --- a/gdk/gdkdrop.c +++ b/gdk/gdkdrop.c @@ -17,6 +17,28 @@ * Authors: Benjamin Otte */ +/** + * SECTION:gdkdrop + * @Title: Drag And Drop + * @Short_description: Functions for controlling drag and drop handling + * + * These functions provide a low-level interface for drag and drop. + * + * The `GdkDrop` object represents the target side of an ongoing DND operation. + * Possible drop sites get informed about the status of the ongoing drag operation + * with events of type %GDK_DRAG_ENTER, %GDK_DRAG_LEAVE, %GDK_DRAG_MOTION and + * %GDK_DROP_START. The `GdkDrop` object can be obtained from these + * [class@Gdk.Event] types using [method@Gdk.DndEvent.get_drop]. + * + * The actual data transfer is initiated from the target side via an async + * read, using one of the `GdkDrop` methods for this purpose: + * [method@Gdk.Drop.read_async] or [method@Gdk.Drop.read_value_async]. + * + * GTK provides a higher level abstraction based on top of these functions, + * and so they are not normally needed in GTK applications. See the + * "Drag and Drop" section of the GTK documentation for more information. + */ + #include "config.h" #include "gdkdropprivate.h" -- 2.30.2